Index

api/v1/stock/{stockno}/locations

Path: api/v1/stock/{stockno}/locations

This API is JSON:API compliant.

This endpoint supports the following methods:
GET

The resource type for this endpoint is StockLocations
The identifier is stockNo-locationNo

The StockLocations resource type attributes are as follows:

{
"line":integer
The internal branch number used to identify the branch. This will only be returned if branch is enabled.
optional
"branchNo":integer Note: Will not be returned in the response if value is null.
The branch code. This will only be returned if branch is enabled.
"branchCode":string Note: Will not be returned in the response if value is null.
The internal location number used to identify the location.
"locationNo":integer
"locationCode":string
The Min Qty Low and Min Qty High procurement parameters provide a window for purchasing, and provide a way of batching orders, rather than ordering the same stock every day.
optional
"minQtyLow":number Note: Will not be returned in the response if value is null.
optional
"minQtyHigh":number Note: Will not be returned in the response if value is null.
Limit Qty provides a way of putting an absolute limit on how much stock to order.
optional
"limitQty":number Note: Will not be returned in the response if value is null.
Reorder Qty can be at a stock or stock location level. If a location level reorder quantity is specified it will be used, otherwise the stock’s default reorder quantity will be used.
optional
"reorderQty":number Note: Will not be returned in the response if value is null.
Days Supply allows users to specify how many days’ worth of this stock they wish to purchase or transfer, based on average usage.
optional
"daysSupply":integer Note: Will not be returned in the response if value is null.
Zones are a further extension of the warehouse management process that enhance the usability of warehousing. This is used only if the Jim2 licence key includes Warehouse Management.
"zone":string Note: Will not be returned in the response if value is null.
Bin – the space within a bay/level combination.
"primaryBin1":string Note: Will not be returned in the response if value is null.
Max Qty allows entering the maximum quantity that will fit in the bin. This is used only if the Jim2 licence key includes Warehouse Management.
optional
"maxQtyBin1":number Note: Will not be returned in the response if value is null.
This is used only if the Jim2 licence key includes Warehouse Management.
"primaryBin2":string Note: Will not be returned in the response if value is null.
This is used only if the Jim2 licence key includes Warehouse Management.
optional
"maxQtyBin2":number Note: Will not be returned in the response if value is null.
optional
"configNo":integer Note: Will not be returned in the response if value is null.
}

Example GET (Return all)

Path: api/v1/stock/2/locations

Response:

{
  "data": [
    {
      "id": "2-1",
      "type": "StockLocations",
      "attributes": {
        "line": 1,
        "locationNo": 1,
        "locationCode": "ACT",
        "minQtyLow": 1.0,
        "minQtyHigh": 10.0,
        "LimitQty": 20.0,
        "ReorderQty": 5.0,
        "daysSupply": 5,
        "zone": "A",
        "primaryBin1": "1.2.3.BIN1",
        "maxQtyBin1": 1.0,
        "primaryBin2": "A.A.1.1.2",
        "maxQtyBin2": 20.0
      }
    },
    {
      "id": "2-2",
      "type": "StockLocations",
      "attributes": {
        "line": 2,
        "locationNo": 2,
        "locationCode": "NSW",
        "minQtyLow": 2.0,
        "minQtyHigh": 11.0,
        "LimitQty": 21.0,
        "ReorderQty": 6.0,
        "daysSupply": 6,
        "zone": "A",
        "primaryBin1": "A.A.1.2.2",
        "maxQtyBin1": 2.0,
        "primaryBin2": "A.A.2.3.1",
        "maxQtyBin2": 3.0
      }
    },
    {
      "id": "2-3",
      "type": "StockLocations",
      "attributes": {
        "line": 3,
        "locationCode": "NT"
      }
    }
  ]
}

Example GET (Return specific)

Path: api/v1/stock/2/locations/2-2

Response:

{
	"data": {
		"id": "2-2",
		"type": "StockLocations",
		"attributes": {
			"line": 2,
			"locationNo": 2,
			"locationCode": "NSW",
			"minQtyLow": 2.0,
			"minQtyHigh": 11.0,
			"LimitQty": 21.0,
			"ReorderQty": 6.0,
			"daysSupply": 6,
			"zone": "A",
			"primaryBin1": "A.A.1.2.2",
			"maxQtyBin1": 2.0,
			"primaryBin2": "A.A.2.3.1",
			"maxQtyBin2": 3.0
		},
		"links": {
			"self": "/api/v1/stock/2/locations/2-2"
		}
	}
}

Generated from Jim2 version 4.6.9804.70